home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-11 / pdrd2.zip / RD.ZIP / SYNTAX.RD < prev   
Text File  |  1993-01-11  |  2KB  |  42 lines
  1. /*
  2.         SYNTAX.RD
  3. */
  4.  
  5.  
  6. ADread( <getlist>, [bConfig], [nInitGet], [lKill] ) --> <aReadRetval>
  7. ---------------------------------------------------------------------
  8. <getlist> is the array of Get objects to read.
  9.  
  10. [bConfig]
  11.  
  12. [nInitGet] is the numeric index position of the Get to initially focus.
  13. Defaults to 1.
  14.  
  15. [lKill] is a logical value.  If it is FALSE, the Read engine created by
  16. ADread() is preserved alive, and may be reactivated using the API,
  17. ADr_again().  Defaults to TRUE.
  18.  
  19.  
  20. <aReadRetval> is the return value.  It is an array of the following:
  21. structure:
  22.  
  23.    1 - the numeric identifier of the Read engine created by ADread().
  24.        This value is nil if ADread() has not been configured to preserve
  25.        the engine at exit.  By default is is automatically killed.  The
  26.        engine identifier is the gateway to reconfiguring the behaviour
  27.        of ADread().  See Config.rd for a full discussion of how to
  28.        change it behaviour via the various APIs.
  29.  
  30.    2 - is the numeric exit code.  It is equal to the inkey() code of the
  31.        exit key unless:
  32.           a. ADread was exited with the mouse right button, in which case
  33.              its value is RX_MOUSE.
  34.           b. ADread was exited because SET CONFIRM was FALSE, and the
  35.              current Get is the last Get, and it exited when the Get edit
  36.              buffer was fully filled.  The exit code is then RX_NOCONFIRM.
  37.           c. ADread was programmatically aborted.  (RX_ABORT).
  38.           d. ADread was programmatically saved/exited.  (RX_SAVE).
  39.  
  40.           NOTE: RX_MOUSE, RX_NOCONFIRM, RX_ABORT and RX_SAVE are #DEFINEd
  41.                 in Read.ch.
  42.